home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 98 / Skunkware 98.iso / src / shellutil / gzip-1.2.4.tar / gzip-1.2.4 / INSTALL < prev    next >
Text File  |  1993-08-19  |  11KB  |  274 lines
  1. This is a generic INSTALL file for utilities distributions.
  2. Some features specific to gzip have been added.
  3.  
  4. To compile this package:
  5.  
  6. 1.  Configure the package for your system.  In the directory that this
  7. file is in, type `./configure'.  If you're using `csh' on an old
  8. version of System V, you might need to type `sh configure' instead to
  9. prevent `csh' from trying to execute `configure' itself. If you
  10. are using Ultrix, you might need to type `sh5 configure' to avoid
  11. bugs in /bin/sh. Note that 'sh -x configure' may give different results
  12. than 'sh configure', making it difficult to debug configure scripts.
  13.  
  14. The `configure' shell script attempts to guess correct values for
  15. various system-dependent variables used during compilation, and
  16. creates the Makefile(s) (one in each subdirectory of the source
  17. directory).  In some packages it creates a C header file containing
  18. system-dependent definitions.  It also creates a file `config.status'
  19. that you can run in the future to recreate the current configuration.
  20.  
  21. Running `configure' takes a minute or two.  While it is running, it
  22. prints some messages that tell what it is doing.  If you don't want to
  23. see the messages, run `configure' with its standard output redirected
  24. to `/dev/null'; for example, `./configure >/dev/null'.
  25.  
  26. To compile the package in a different directory from the one
  27. containing the source code, you must use a version of `make' that
  28. supports the VPATH variable, such as GNU `make'.  `cd' to the directory
  29. where you want the object files and executables to go and run
  30. `configure'.  `configure' automatically checks for the source code in
  31. the directory that `configure' is in and in `..'.  If for some reason
  32. `configure' is not in the source code directory that you are
  33. configuring, then it will report that it can't find the source code.
  34. In that case, run `configure' with the option `--srcdir=DIR', where
  35. DIR is the directory that contains the source code.
  36.  
  37. By default, `make install' will install the package's files in
  38. /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify an
  39. installation prefix other than /usr/local by giving `configure' the option
  40. `--prefix=PATH'.  Alternately, you can do so by consistently giving a value
  41. for the `prefix' variable when you run `make', e.g.,
  42.     make prefix=/usr/gnu
  43.     make prefix=/usr/gnu install
  44.  
  45. You can specify separate installation prefixes for
  46. architecture-specific files and architecture-independent files.  If
  47. you give `configure' the option `--exec-prefix=PATH' or set the
  48. `make' variable `exec_prefix' to PATH, the package will use PATH as
  49. the prefix for installing programs and libraries.  Data files and
  50. documentation will still use the regular prefix.  Normally, all files
  51. are installed using the regular prefix.
  52.  
  53. Another `configure' option is useful mainly in `Makefile' rules for
  54. updating `config.status' and `Makefile'.  The `--no-create' option
  55. figures out the configuration for your system and records it in
  56. `config.status', without actually configuring the package (creating
  57. `Makefile's and perhaps a configuration header file).  Later, you can
  58. run `./config.status' to actually configure the package.  You can also
  59. give `config.status' the `--recheck' option, which makes it re-run
  60. `configure' with the same arguments you used before.  This option is
  61. useful if you change `configure'.
  62.  
  63. `configure' ignores any other arguments that you give it.
  64.  
  65. If your system requires unusual options for compilation or linking
  66. that `configure' doesn't know about, you can give `configure' initial
  67. values for some variables by setting them in the environment.  In
  68. Bourne-compatible shells, you can do that on the command line like
  69. this:
  70.     CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
  71.  
  72. For csh compatible shells, you can do something like this:
  73.  
  74.     (setenv CC 'gcc -traditional' ; ./configure)
  75.  
  76. The `make' variables that you might want to override with environment
  77. variables when running `configure' are:
  78.  
  79. (For these variables, any value given in the environment overrides the
  80. value that `configure' would choose:)
  81. CC        C compiler program.
  82.         Default is `cc', or `gcc' if `gcc' is in your PATH.
  83. INSTALL        Program to use to install files.
  84.         Default is `install' if you have it, `cp' otherwise.
  85.         If you have an non-standard `install', use INSTALL="cp -p"
  86.  
  87. (For these variables, any value given in the environment is added to
  88. the value that `configure' chooses:)
  89. DEFS        Configuration options, in the form `-Dfoo -Dbar ...'
  90. CFLAGS        Compiler options, such as `-O -g ...'
  91. LIBS        Libraries to link with, in the form `-lfoo -lbar ...'
  92.  
  93. If you need to do unusual things to compile the package, we encourage
  94. you to figure out how `configure' could check whether to do them, and
  95. mail diffs or instructions to the address given in the README so we
  96. can include them in the next release.
  97.  
  98. 2.  Type `make' to compile the package.  If you want, you can override
  99. the `make' variables CFLAGS and LDFLAGS like this:
  100.  
  101.     make CFLAGS=-O2 LDFLAGS=-s
  102.  
  103. 3.  The package comes with self-tests. If you want to run them,
  104. type `make check'.
  105.  
  106. 4.  Type `make install' to install programs, data files, and
  107. documentation. This creates links between gzip, gunzip and zcat.
  108. You can create additional links uncompress, ungzip and gzcat if
  109. you prefer these names. You can also create links to unpack and pcat
  110. if your system uses packed files by default and you want to transform
  111. them transparently to gzip'ed files.
  112.  
  113. If you wish to use only the name gzcat and not overwrite an existing zcat, use:
  114.  
  115.     make ZCAT=gzcat install
  116.  
  117. The man pages are installed by default with an extension `.1' (one).
  118. If you want the extension `.l' (lower case L) use:
  119.  
  120.     make manext=l install
  121.  
  122. If you are using csh or tcsh, you must type `rehash' after `make install'
  123. to make sure that the command `gzip' will invoke the new executable.
  124.  
  125. 5.  You can remove the program binaries and object files from the
  126. source directory by typing `make clean'.  To also remove the
  127. Makefile(s), the header file containing system-dependent definitions
  128. (if the package uses one), and `config.status' (all the files that
  129. `configure' created), type `make distclean'.
  130.  
  131. The file `configure.in' is used as a template to create `configure' by
  132. a program called `autoconf'.  You will only need it if you want to
  133. regenerate `configure' using a newer version of `autoconf'.
  134.  
  135. 6.  You  can add the following  lines  to your  /etc/magic file so that
  136. file(1), if  your system supports it,  will recognize files created by
  137. gzip:
  138.  
  139. 0    string        \037\213    gzip compressed data
  140. >2    byte        8        - deflate method
  141. >3    byte        &0x1        , ascii
  142. >3    byte        &0x2        , continuation
  143. >3    byte        &0x4        , extra field
  144. >3    byte        &0x8        , original file name
  145. >3    byte        &0x10        , comment
  146. >3    byte        &0x20        , encrypted
  147. >8    byte        2        , max compression
  148. >8    byte        4        , max speed
  149.  
  150. If your version of 'file' does not accept octal numbers in strings, replace the
  151. first line with one of these:
  152.  
  153. 0    short        0x8b1f        gzip compressed data
  154. 0    short        0105437        gzip compressed data
  155.  
  156. 0    short        0x1f8b        gzip compressed data
  157. 0    short        017613        gzip compressed data
  158.  
  159. Use the first or second form if your machine is a 386 or a Vax or a
  160. MIPS configured in little-endian mode or any other little-endian
  161. machine. Use the third or fourth form on big-endian machines.
  162. On some systems, the field separators must contain only tabs (no spaces).
  163.  
  164. 7. To rename .z files with the new .gz suffix, you can use or adapt
  165.    the following shell script:
  166.  
  167. #!/bin/sh
  168. find . -name '*.z' -type f -print | while read i
  169. do
  170.     new=`echo "$i" | sed 's/\.z$/.gz/'`
  171.     mv "$i" "$new" || echo Failed renaming $i to $new
  172. done
  173.  
  174. If you wish to keep the old .z suffix as default without setting the
  175. GZIP environment variable to "--suffix .z", you can compile gzip with:
  176.  
  177.    make CFLAGS='-DZ_SUFFIX=\".z\"'
  178.  
  179.  
  180. 8.  Special targets
  181.  
  182. - For MSDOS, OS/2, VMS, Atari, Amiga, Primos, use the makefile or command
  183.   file provided in the appropriate subdirectory. For Turbo C++ 1.0, read
  184.   the warning at the top of Makefile.bor.
  185.  
  186. - On some systems memcpy() may not work as expected. (Problem found on
  187.   Pyramid only so far.) If you get "crc error" on some .gz files, add
  188.   -DNOMEMCPY to CFLAGS and recompile inflate.o. For example:
  189.     rm -f inflate.o
  190.     make CFLAGS="-O2 -DNOMEMCPY"
  191.  
  192.   The memcpy problem affects only gunzip, not gzip. You can safely define
  193.   -DNOMEMCPY on all systems, but this may degrade performance of gunzip.
  194.  
  195. - If your system is a pure BSD system but incorrectly links string.h to
  196.   strings.h, you may get undefined mem* and str* symbols. Try recompiling with
  197.  
  198.       make clean
  199.       make CFLAGS="-DNO_STRING_H"
  200.  
  201. - On some systems (reported on Dec Ultrix), "cc -E" and /lib/cpp behave
  202.   differently. If you have trouble with the default configuration, try:
  203.  
  204.     CPP=/lib/cpp ./configure
  205.     make clean
  206.     make
  207.  
  208. - On Ultrix, /bin/sh is too buggy. Use "sh5 configure" instead of "configure".
  209.   
  210. - On Mips Dec Ultrix, gunzip behaves non-deterministically with regard
  211.   to some .gz files. The same command either succeeds or gives a CRC error.
  212.   This problem is still being investigated. The files produced by gzip
  213.   are correct (can reliably be extracted on other systems).
  214.  
  215. - On Xenix, some preprocessors do not define M_XENIX. You may have to do:
  216.  
  217.     DEFS='-DM_XENIX' ./configure
  218.  
  219. - On Xenix 2.3.2 for 286, do: make xenix_286
  220.  
  221. - On Coherent, do: make coherent
  222.  
  223. - On NeXTstep 3.1, many people (but not all) have had trouble with
  224.   configure. Try first
  225.  
  226.     (setenv DEFS -DNO_UTIME_H; ./configure)
  227.     make test
  228.  
  229.   If this fails, then try "make next". configure should work correctly
  230.   on NeXTstep versions up to 3.0.
  231.  
  232.   To build a gzip package that can run on either the m68k or i386 family,
  233.   use configure then "make next-fat".
  234.  
  235.   On some versions of NeXT, either "cc -finline-functions" or "cc -O4"
  236.   is broken. gzip produces valid .gz files but they are much too large
  237.   because the string matching code misses most matches. Use "cc -O" instead.
  238.  
  239. - There is an optimization bug in the IRIX 4.0.5 IDO 4.1 assembler which is
  240.   triggered by GCC -O.  IDO 4.1.1 should fix this.  If you have to use IDO 4.1
  241.   then you can avoid the bug in one of the following ways:
  242.  
  243.   1. Use SGI CC
  244.   2. Add the -noasmopt flag to GCC
  245.   3. Reconfigure GCC with the "mips-sgi-irix4loser" target which effectively
  246.      does the same as specifying "-noasmopt" all by default.
  247.   4. Don't use -O at all with GCC.
  248.  
  249. - On Solaris 2.1 for x86, the January 1993 "OEM" compiler release
  250.   generates bad code. This is fixed in the June 1993 "FCS" release.
  251.  
  252. - on Sparc with SunOS 4.1.1 and the SC1.0 compiler, the optimizer
  253.   works up to -O3 but -O4 does not work.
  254.  
  255. - MSC 5.1 with -Ox and -DDYN_ALLOC generates bad code in inflate.c.
  256.   The default is static allocation (no DYN_ALLOC) and -Ox works on inflate.c.
  257.   But -Ox does not work on util.c and unlzh.c, so you must use -Oait -Gs.
  258.  
  259. - The exit() function in Turbo C++ 1.0 seems to be broken. gzip crashes
  260.   even if exit(0) is the first statement in main(). The problem is avoided
  261.   by adding -Dexit=_exit  to CFLAGS in Makefile.bor.
  262.  
  263. - On dnix 5.3 2.2 cc version 2.37c is buggy. Version 2.38d works.
  264.  
  265. - On an Alliant running Concentrix, cc (even without optimization) generates
  266.   incorrect code. You have to use gcc.
  267.  
  268. - On Cray running CSOS 1.0 with compiler version dev-125, you must compile
  269.   with the flag "-hnoopt" to avoid an optimizer bug.
  270.  
  271. - On HPUX, configure can't find a correct install. Use:
  272.  
  273.    INSTALL=/usr/local/bin/bsdinst ./configure
  274.